home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / editor / vtext100.zip / COMPILE.DOC < prev    next >
Text File  |  1996-07-22  |  37KB  |  753 lines
  1.  
  2.  
  3.                          The Visual Text Publisher
  4.  
  5.  
  6.       Description:
  7.  
  8.       The Visual Text Publisher (or  "V-Text" for short) allows you  to
  9.       create  "electronic"  books  or  magazines,  such  as  tutorials,
  10.       training  manuals,  or  even  works  of  literature.   The V-Text
  11.       system allows you to create professional looking,  self-executing
  12.       programs with little effort.   V-Text uses ASCII text files  that
  13.       you create on your own, and then compiles them into a  graphical,
  14.       on-line  "electronic"  book.   If  you  know  how  to  use a word
  15.       processor then you have all the skills necessary to  publish your
  16.       own "electronic" books that you can then  distribute on diskette.
  17.       The electronic books that  you create with  V-Text can be copied,
  18.       distributed and sold,  royalty free!   Share your knowledge, your
  19.       research, your works of poetry, fiction  with others by using The
  20.       Visual Text Publisher!
  21.  
  22.  
  23.  
  24.       Features:
  25.  
  26.       V-Text  allows  you  to  customize  your  electronic   documents.
  27.       Consider the following...  V-Text allows you to...
  28.  
  29.       + Consolidate all your text files into just one compact data
  30.         file.  In fact, after compilation, only two files are
  31.         necessary to make your electronic book available to your
  32.         audience (READ.EXE and READ.DAT).  This makes disk
  33.         distribution file management a breeze.
  34.  
  35.       + Display 16 color .PCX graphic images alongside your text
  36.  
  37.       + Include branching sub-menus.  Jump to a different chapter
  38.         or section of your electronic book when you press a predefined
  39.         hot-key.
  40.  
  41.  
  42.       Special requirements:
  43.  
  44.       The Visual Text  Publisher requires a  IBM PC using  DOS versions
  45.       3.0 to 6.22 or Windows 3.x  or Windows 95.  V-Text also  requires
  46.       a VGA monitor and adapter.
  47.  
  48.  
  49.       Before we get started:
  50.  
  51.       This documentation has been written to be concise and helpful  as
  52.       possible.  We suggest that you print out a copy of this file  and
  53.       keep it  near you  as you  work on  the sample  projects provided
  54.       with this program.
  55.  
  56.       Before you  compile your  very own  electronic book  we recommend
  57.       that you browse through one  that has already been created.   You
  58.       should  find  a  file  AESOP.DAT  on  your disk, which contains a
  59.       short  collection  of  Aesop's  Fables.   To view this electronic
  60.       book from the DOS prompt enter: READ AESOP   then press  [ENTER].
  61.       Browse  through  this  electronic  book  and  get a feel for what
  62.       V-Text can  do.   If you  like what  you see,  and would  like to
  63.       create   similar   V-Text   documents,   resume   reading   these
  64.       instructions and proceed with your first compilation.
  65.  
  66.  
  67.       Terms and definitions:
  68.  
  69.       There  are  several  terms  that  will  be  used  throughout this
  70.       documentation and that  need to be  fully understood by  the user
  71.       before  you  create  your  own  electronic  books.  Please review
  72.       these definitions carefully:
  73.  
  74.       ASCII FILE: This  is a term  used to describe  any file that  you
  75.       create and  save with  an editor  such as  DOS' EDIT  or Window's
  76.       Notepad.   An ASCII  file contains  only characters  that can  be
  77.       found on a standard IBM  keyboard.  Most word processor  programs
  78.       (like  Word  Perfect)  can  save  files  in  ASCII  format IF you
  79.       specifically instruct the  program to do  so.  The  reason V-Text
  80.       does NOT come with an  editor is because most users  already have
  81.       a  favorite  text  editor  or  word  processor  that  they   feel
  82.       comfortable with.   We saw  no reason  to force  the user  to use
  83.       another editor and have consequently not included one.
  84.  
  85.       CHAPTER: A  chapter is  any ASCII  or text  file that  you create
  86.       that you want to become  part of your electronic book.   Chapters
  87.       are simply individual text files, and can be identified by  their
  88.       DOS file extension.  Example: AESOP.1 for chapter 1, AESOP.2  for
  89.       chapter 2, etc.  Chapters must not exceed 32,000 bytes in size.
  90.  
  91.       COMPILER: The compiler is the program that merges and  compresses
  92.       your ASCII text files, and graphic files into a single data  file
  93.       (READ.DAT).
  94.  
  95.       DATA FILE:   The data  file is  a specially  formatted file  that
  96.       contains ALL of  your chapters and  graphics.  This  data file is
  97.       created by using the  V-Text compiler (COMPILE.EXE), and  once it
  98.       has been  created it  can be  identified by  the default filename
  99.       "READ.DAT".   This data  file is  one of  the two necessary files
  100.       that  must  be  placed  on  your  distribution  disk in order for
  101.       others to read your electronic  book.  Data files can  be renamed
  102.       if you  wish, however  to use  them with  the "reader" (READ.EXE)
  103.       you must specify its new file name on the DOS command line.   For
  104.       example,  AESOP.DAT  was  originally  named  READ.DAT,  but   was
  105.       renamed  in   order  to   preserve  its   contents  from   future
  106.       compilations  that  would  have  created  a new READ.DAT file and
  107.       overwritten  it.   To  use  AESOP.DAT  with  the  "reader" module
  108.       (READ.EXE), the user needs to start the electronic book from  the
  109.       DOS command line in this manner:  READ AESOP.DAT   By using  this
  110.       method  inside  a  batch  file,  the  author  can  create several
  111.       electronic books on  one floppy disk,  needing only one  "reader"
  112.       module.
  113.  
  114.       READER MODULE:  This refers to the file "READ.EXE".  This is  the
  115.       program  that  reads  the  information  in  your  data  file  and
  116.       displays it to  your audience.   Remember, in order  to create an
  117.       electronic book for distribution on a floppy diskette, two  files
  118.       must exist on that disk: 1) READ.EXE and 2) READ.DAT.
  119.  
  120.       TEXT FILE:   Text files  and ASCII  files all  refer to  the same
  121.       thing (see ASCII FILE above).
  122.  
  123.       PCX FILE: This is a bitmap  graphic file that can be used  inside
  124.       your electronic  document.   You can  create PCX  files using  PC
  125.       Paintbrush,  Windows'  3.x  Paintbrush,  Electronic  Arts' Deluxe
  126.       Paint  II  (my  favorite),  NeoPaint  (shareware available on our
  127.       BBS), or  any other  paint program.   Although PCX  files can  be
  128.       found in  Black &  White, 16  color and  256 color format, V-Text
  129.       only supports 16 color .PCX files.
  130.  
  131.  
  132.       Getting started:
  133.  
  134.       You will  need to  create all  of the  ASCII text  files that you
  135.       wish to  include in  your "electronic"  book BEFORE  you run  the
  136.       compiler  (COMPILE.EXE).   Use  your  favorite  word processor or
  137.       text  editor  (like   DOS'  EDIT)  to   compose  the   individual
  138.       "chapters".   If  you  are  using  a  word  processor,  like Word
  139.       Perfect,  then  it  is  absolutely  essential  that you save each
  140.       "chapter" as an  ASCII file.   Most word processors  add "control
  141.       characters"  to  your  document  as  you  compose  it.    Control
  142.       characters   are   used   to   identify   italics,  highlighting,
  143.       underlines, margin spacing,  etc.  When  using a word  processor,
  144.       these control  characters will  create problems  if they  are not
  145.       removed.  By saving a word processing document as an ASCII  file,
  146.       all the control characters will be removed.
  147.  
  148.       In Word Perfect 5.0/5.1, you  can save your document as  an ASCII
  149.       file  by  pressing  CTRL+F5,  then  selecting  "1 DOS Text", then
  150.       select "1 Save".
  151.  
  152.       If you are using DOS' EDIT, or the Windows' Notepad, then you  do
  153.       not  need  to  worry  about  control characters, for their native
  154.       file formats are ASCII.
  155.  
  156.       Each "chapter"  of your  electronic book  MUST exist  as an ASCII
  157.       file.  The manner in which you save and name your ASCII files  is
  158.       absolutely CRITICAL!  The file  extensions must be a number,  and
  159.       must  correspond  to  the  chapter  contained  within  it.    For
  160.       example, AES